pp108 : parameters Property (Busdataisland)

parameters Property (Busdataisland)


Array (Collection) that contains all the parameters that can be specified on the URL to which SOAP Messages are posted.

Syntax

Inline HTML

N/A.

Event property

busdataislandID.parameters[paramName] = paramValue


Parameters

Parameter

Description

paramName

String that denotes the name of the parameter.

paramValue

Variant that denotes the value that can be set to the parameter.


Remarks


The parameters array is a collection that contains the parameters indexed by their names. The following example sets the organization parameter in the parameters property.

Scripting

bdiIsland.parameters.organization = "o=system,cn=cordys,o=vanenburg.com";



Where bdiIsland denotes the ID of the busdataisland. This will be added to the URL of the gateway as follows:

url

http://<machineName>/com.eibus.Web.soap.Gateway.wcp? organization="o=system,cn=cordys,o=vanenburg.com"



The value of each parameter in the properties can be a variant (such as String, Boolean, or Integer) and can also be of a type array. If it is of type array then the values within it are added as separate parameters as in the following example:

Scripting

bdiEmployees.parameters.receiver = new Array("SOAP DN1", "SOAP DN2");



In such cases the URL will look like below:

url

http://<machineName>/com.eibus.Web.soap.Gateway.wcp?receiver="SOAP DN1"&receiver="SOAP DN2"



The following are the parameters that are understood by the default Web gateway:

Parameter

Description

organization

String that denotes the organizational context at which the request is sent.

receiver

String or array that denotes the distinguished name of the SOAP Node, SOAP Processor, or Connection Point to which the request is to be sent.

timeout

Integer in milliseconds that denotes how long the Web server should wait for the response from the back end. If the specified time elapses, then a timeout exception is thrown.

messageId

String that denotes the message ID that the Web gateway should put in the Header of the SOAP message. This ID is used for message correlations and hence it is advised not to reuse the same message ID at the same time, even if it comes from different browsers.

norespone

Boolean that sets or retrieves one of the following values:

  • true-Web Gateway should send a SOAP message to the back end, but should not wait for a response.
  • false- Web Gateway should send a SOAP message to the back end and should wait for a response.

url

Read-only. Retrieves the URL address of the Web Gateway to which the requests are send. By default, this iscom.eibus.Web.soap.Gateway.wcp. This property can be set through the system component's baseurl property.


Example


This sample code demonstrates how the event can be used.

<!-- Busdataisland definition -->
<div cordystype "wcp.library.data.BusDataIsland" id="bdiEmployees" async="false" request="constructor.XMLDocument" onrequest="setParameters()"></div>
//Function called on onrequest event of the busdataisland
function setParameters()
{
    //Set the organization and receiver
    bdiEmployees.parameters["organization"] = "o=system,cn=cordys,o=vanenburg.com";
    bdiEmployees.parameters["receiver"] = "cn=Northwind Service,cn=soap nodes,o=system,cn=cordys,o=vanenburg.com";
}

See Also


busdataisland